Skip to content

Migration #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 41 commits into
base: preview
Choose a base branch
from
Open

Migration #128

wants to merge 41 commits into from
+41,394 −7,265

Conversation

aheckmann
Copy link
Member

@aheckmann aheckmann commented Jul 30, 2025 •
edited
Loading

Description

  • Migrate to docusaurus
  • Migrate to Vercel
  • Update branding
  • Add SDKs, Apps and AI Solutions sections
  • Refactor webhooks guide and add more examples
  • Add welcome page
  • Various content improvements
  • Ensure all old urls redirect correctly

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Please visit the Vercel preview.

image image image image image

@vercel Vercel
Copy link

vercel bot commented Jul 30, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
developer-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2025 0:17am

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 30, 2025 •
edited
Loading

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

96 files out of 298 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch v2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aheckmann aheckmann requested a review from Prashant-Surya July 31, 2025 00:31
@Prashant-Surya
Copy link
Member

@aheckmann Our old developer docs used to offer a playground to interact with APIs directly from our website, I couldn't find similar behaviour in the new version. Do we still support this?

Prashant-Surya
Prashant-Surya reviewed Aug 1, 2025
View reviewed changes
docs/api/get-workspace-work-item.api.mdx
>
</Heading>

<ParamsDetails
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the below page, "ExampleIssueIdentifier" looks like a button but there's no action associated with it. Can we change style for this?
CleanShot 2025-08-01 at 13 27 15

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. These are arrays of examples. Often our schema only includes a single item in the examples. Either way, it looks nicer now whether there are a single or multiple examples provided.

image

docs/api/search-work-items.api.mdx
@@ -0,0 +1,71 @@
---
id: search-work-items
title: "search_work_items"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title doesn't seem to be readable as other APIs, should we update this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

API docs are auto-generated from our api spec. Let's fix in the spec.

@aheckmann
Copy link
Member Author

aheckmann commented Aug 1, 2025 •
edited
Loading

Our old developer docs used to offer a playground to interact with APIs directly from our website, I couldn't find similar behaviour in the new version. Do we still support this?

Good catch - I'll re-enable it since it works from developers.plane.so. I had disabled it b/c in my testing, requests from browsers were failing (No 'Access-Control-Allow-Origin' header is present on the requested resource.)

@Prashant-Surya

@aheckmann
chore: rm old file
fb13788 
this was moved into /apps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sriramveeraghanta sriramveeraghanta Awaiting requested review from sriramveeraghanta

@danciaclara danciaclara Awaiting requested review from danciaclara

@Prashant-Surya Prashant-Surya Awaiting requested review from Prashant-Surya

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aheckmann @Prashant-Surya @danciaclara